

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>
<head>
<script type="text/javascript" src="helpman_topicinit.js"></script>

<title>Run Add-In Functions [Enterprise Architect User Guide]</title>

<meta name="keywords" content="Enterprise Architect, Sparx Systems, UML, Add-In,Add-In Run Functions From Tasks Pane,Tasks Pane,Tasks Pane Run Add-In Functions From">
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<meta http-equiv="Content-Style-Type" content="text/css" />

<link type="text/css" href="default.css" rel="stylesheet" />
<style type="text/css">
  A, A:Visited
  {
    color: #00F;
  }

  A:Active, A:Hover
  {
    color: #F00;
  }

  OL
  {
    margin: 5px 0 5px 48px;
  }

  UL
  {
    margin-bottom: 3px;
    margin-top: 0;
  }

  #nsr
  {
    background-color: #D4DFFF;
  }

  #nsr A
  {
    text-decoration: none;
  }

  #mainbody
  {
    padding: 8px;
  }

  .p_BodyText
  {
    padding: 5px 0;
  }
</style>



<style type="text/css" media="screen">
  BODY
  {
    background-color: #FFFFFF;
  }

  #nsr
  {
    padding: 6px 6px 0 6px;
    border-bottom: none;
    vertical-align: top;
    z-index: 2;
    visibility: visible;
    left: 0;
    top: 0;
    position: absolute;
  }

  #mainbody
  {
    left: 0;
    top: 0;
    margin: 0;
    position: absolute;
    padding: 10px;
    overflow: auto;
    height: 100%;
    z-index: 1;
    background-repeat: no-repeat;
    background-position: bottom right;
    background-attachment: fixed;
  }
</style>

<style type="text/css" media="print">
  #nsr
  {
    visibility: none;
  }

  #mainbody
  {
    overflow: visible;
  }
</style>
<script type="text/javascript" language="JavaScript" src="nonscroll.js"></script>

</head>
<body scroll="no">

<div id="page">



        <div id="content">
          <div id="content-inner">
          



  
          <div id="nsr">
            <table border="0" cellspacing="0" cellpadding="4" width="100%">
              <tr valign="top">
                <td align="left">
  


                  <p class="p_Heading1"><span class="f_Heading1">Run Add-In Functions</span></p>



  
                </td>
                <td align="right">
                  <a href="introduction.htm" onmouseover="document.images.main.src='button_main_h.gif'" onmouseout="document.images.main.src='button_main.gif'">
                    <img name="main" src="button_main.gif" border=0 alt="Return to Introduction">
                  </a>&nbsp;
    
                  <a href="built_in_task_pane_commands.htm" onmouseover="document.images.prev.src='button_prev_h.gif'" onmouseout="document.images.prev.src='button_prev.gif'">
                    <img name=prev src="button_prev.gif" border=0 alt="Previous page" />
                  </a>&nbsp;
    
    
    
                  <a href="define_task_pane_contexts.htm" onmouseover="document.images.next.src='button_next_h.gif'" onmouseout="document.images.next.src='button_next.gif'">
                    <img name=next src="button_next.gif" border=0 alt="Next page" />
                  </a>
    
    
                </td>
              </tr>
            </table>
          </div>
          <div id="mainbody">
  


                <p class="p_BodyText"><span class="f_BodyText">To run Add-In functions from the </span><span class="f_UIControl">Tasks Pane</span><span class="f_BodyText">, you create an attribute in the </span><span class="f_UIControl">Tasks Pane</span><span class="f_BodyText"> </span><span class="f_BodyText">&laquo;</span><span class="f_BodyText" style="font-style: italic;">stereotype</span><span class="f_BodyText">&raquo;</span><span class="f_BodyText"> Class with the following format:</span></p>
<p class="p_Code"><span class="f_Code">&quot;Assembly::FunctionName()&quot;</span></p>
<p class="p_BodyText"><span class="f_BodyText">where </span><span class="f_BodyText" style="font-style: italic;">Assembly</span><span class="f_BodyText"> is the name of the Add-In and </span><span class="f_BodyText" style="font-style: italic;">FunctionName</span><span class="f_BodyText"> is the name of a public function in the Add-In. Give the attribute an initial value of the text that is to appear in the </span><span class="f_UIControl">Tasks Pane</span><span class="f_BodyText">. The function receives two parameters and returns a success status, as in the following VB.Net example:</span></p>
<p class="p_Code"><span class="f_Code">&nbsp;</span></p>
<p class="p_Code"><span class="f_Code">Public Function ShowMyDiagram(ByRef Repository As EA.Repository, ByVal args As Object) As String</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code"> &nbsp; Dim ret As String</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code"> &nbsp; ret = Repository.SQLQuery(&quot;select ea_guid from t_diagram where diagram_type='Custom' and StyleEx like</span><br>
<span class="f_Code"> &nbsp;&nbsp;&nbsp;&nbsp; '*;MDGDgm=MyDiagrams::MyCustomDiagram;*'&quot;)</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code"> &nbsp; If ret Is Nothing Then</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code">ShowMyDiagram = False</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code">Exit Function</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code"> &nbsp; End If</span></p>
<p class="p_Code"><span class="f_Code">&nbsp;</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code"> &nbsp; Dim oXML As MSXML2.DOMDocument = New MSXML2.DOMDocument</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code"> &nbsp; oXML.loadXML(ret)</span></p>
<p class="p_Code"><span class="f_Code">&nbsp;</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code"> &nbsp; Dim NodeList As MSXML2.IXMLDOMNodeList = oXML.selectNodes(&quot;//ea_guid&quot;)</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code"> &nbsp; If NodeList.length = 0 Then</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code">ShowMyDiagram = False</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code">Exit Function</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code"> &nbsp; End If</span></p>
<p class="p_Code"><span class="f_Code">&nbsp;</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code"> &nbsp; Dim Node As MSXML2.IXMLDOMNode</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code"> &nbsp; Dim diag As EA.Diagram</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code"> &nbsp; If NodeList.length &gt;= 1 Then</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code">Node = NodeList.item(0)</span></p>
<p class="p_Code"><span class="f_Code">  &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;diag = Repository.GetDiagramByGuid(Node.text)</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code">Repository.OpenDiagram(diag.DiagramID)</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code">Repository.ShowInProjectView(diag)</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code"> &nbsp; End If</span></p>
<p class="p_Code"><span class="f_Code">&nbsp;</span></p>
<p class="p_Code"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Code"> &nbsp; ShowMyDiagram = True</span></p>
<p class="p_Code"><span class="f_Code">End Function</span></p>




            </div>
          </div>
        </div>



</div>


</body>
</html>
